refactor: use requires to assert and automatically log richer information on failure by snawaz · Pull Request #65 · magicblock-labs/ephemeral-spl-token

snawaz · 2026-04-11T19:20:10Z

No breaking changes
Standardized requires macros that not only logs values automatically but the failing expression as well which will be very useful in debugging.
Enforce uniformity, such as accounts destructuring is always the first line in each processor.

Question:

~~Are we passing more accounts than needed by processors?~~
- ~~Based on the existing code, I had to use require_n_accounts_with_ignored!() but I want to use the stricter form require_n_accounts!()~~.

coderabbitai · 2026-04-11T19:20:18Z

Warning

Rate limit exceeded

@snawaz has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 14 minutes and 5 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 14 minutes and 5 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 089f58cf-a321-4ebe-b9ac-13886f1d14b9

📥 Commits

Reviewing files that changed from the base of the PR and between c8f76cd and 834f628.

⛔ Files ignored due to path filters (1)

Cargo.lock is excluded by !**/*.lock

📒 Files selected for processing (44)

e-token-api/Cargo.toml
e-token-api/src/error.rs
e-token-api/src/lib.rs
e-token-api/src/requires.rs
e-token/src/processor/allocate_transfer_queue.rs
e-token/src/processor/close_ephemeral_ata.rs
e-token/src/processor/close_lamports_pda_intent.rs
e-token/src/processor/close_shuttle_ata_intent.rs
e-token/src/processor/create_ephemeral_ata_permission.rs
e-token/src/processor/delegate_ephemeral_ata.rs
e-token/src/processor/delegate_ephemeral_ata_permission.rs
e-token/src/processor/delegate_shuttle_ephemeral_ata.rs
e-token/src/processor/delegate_transfer_queue.rs
e-token/src/processor/deposit_and_delegate_shuttle_ephemeral_ata_with_merge.rs
e-token/src/processor/deposit_and_delegate_shuttle_ephemeral_ata_with_merge_and_private_transfer.rs
e-token/src/processor/deposit_and_queue_transfer.rs
e-token/src/processor/deposit_spl_tokens.rs
e-token/src/processor/ensure_transfer_queue_crank.rs
e-token/src/processor/execute_ready_queued_transfer.rs
e-token/src/processor/initialize_ephemeral_ata.rs
e-token/src/processor/initialize_global_vault.rs
e-token/src/processor/initialize_rent_pda.rs
e-token/src/processor/initialize_shuttle_ephemeral_ata.rs
e-token/src/processor/initialize_transfer_queue.rs
e-token/src/processor/internal/ephemeral_ata.rs
e-token/src/processor/internal/lamports_pda.rs
e-token/src/processor/internal/shuttle_delegation.rs
e-token/src/processor/internal/token_vault.rs
e-token/src/processor/internal/transfer_queue_refill.rs
e-token/src/processor/mark_transfer_queue_refill_pending.rs
e-token/src/processor/merge_shuttle_into_ephemeral_ata.rs
e-token/src/processor/pending_transfer_queue_refill.rs
e-token/src/processor/reset_ephemeral_ata_permission.rs
e-token/src/processor/sponsored_lamports_transfer.rs
e-token/src/processor/transfer_lamports_pda.rs
e-token/src/processor/transfer_queue_tick.rs
e-token/src/processor/undelegate_and_close_shuttle_to_owner.rs
e-token/src/processor/undelegate_ephemeral_ata.rs
e-token/src/processor/undelegate_ephemeral_ata_permission.rs
e-token/src/processor/undelegate_lamports_pda.rs
e-token/src/processor/undelegation_callback.rs
e-token/src/processor/utils/token.rs
e-token/src/processor/withdraw_spl_tokens.rs
e-token/src/processor/withdraw_through_delegated_shuttle_with_merge.rs

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch snawaz/requires

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

snawaz · 2026-04-11T19:20:24Z

This stack of pull requests is managed by Graphite. Learn more about stacking.

Dodecahedr0x

require_n_accounts is more restrictive than the current implem. I don't thinks it's a bad thing (tx data is already a limit) but it's also unnecessary IMO in this PR

Plus small suggestions

Dodecahedr0x · 2026-04-13T16:55:03Z

+#[macro_export]
+macro_rules! require {
+    ($cond:expr, $error:expr) => {{
+        if !$cond {


they can all use core::hiint::unlikely to improve perfs (tried it locally, up to 600 CU gains on some instructions, requires nightly)

Yes. I could use that. But 600 CU is very unlikely (pun not intended), because if usually consumes 4 to 6 CU.

I'm not addressing this in this PR. Will consider doing it in the coming PRs. We'll probably move requires.rs to some common library crate.

Sure, can be done in another PRs, it just felt appropriate since introducing all the requires.

FYI, here's the benchmark by just adding unlikely. It probably indicates that either the compiler does some weird stuff, or we are doing too many checks on some paths.

─────────────────────────────────────────────────────────────────────────────── Key Baseline CU Current CU Δ CU Δ % ─────────────────────────────────────────────────────────────────────────────── close_eata::close 1,726 1,723 -3 -0.17% create_eata_perm::default 13,709 13,569 -140 -1.02% create_eata_perm::permissionless 24,198 24,058 -140 -0.58% del_eata::delegate 43,435 43,337 -98 -0.23% del_eata::non_owner 29,935 29,837 -98 -0.33% del_eata::redelegate 152 152 +0 +0.00% del_eata::reinit 7,713 7,716 +3 +0.04% del_eata_perm::delegate 48,487 48,485 -2 -0.00% del_eata_perm::non_owner 52,987 52,985 -2 -0.00% del_eata_perm::redelegate 175 174 -1 -0.57% del_shuttle_eata::delegate 25,546 25,434 -112 -0.44% del_shuttle_eata::redelegate 173 160 -13 -7.51% del_shuttle_merge::delegate 80,548 79,861 -687 -0.85% del_shuttle_priv::queue 27,991 27,890 -101 -0.36% del_shuttle_priv::shuttle 128,773 128,086 -687 -0.53% del_tq::delegate 23,491 23,390 -101 -0.43% del_tq::redelegate 1,793 1,794 +1 +0.06% dep_queue::accepts_legacy_destination_ata 13,509 13,503 -6 -0.04% dep_queue::all_splits_use_client_ref_id 10,980 10,976 -4 -0.04% dep_queue::assign_group_id_0 10,712 10,706 -6 -0.06% dep_queue::assign_group_id_1 11,180 11,174 -6 -0.05% dep_queue::deterministic_delays 11,383 11,377 -6 -0.05% dep_queue::once_split 10,953 10,947 -6 -0.05% dep_queue::reject_delay_range 576 574 -2 -0.35% dep_queue::reject_queue_full 289 282 -7 -2.42% dep_queue::reject_split_gt_amt 573 572 -1 -0.17% dep_queue::reject_zero_split 571 569 -2 -0.35% dep_queue::return_to_shuttle 7,851 7,844 -7 -0.09% dep_queue::split3_mod5 11,152 11,146 -6 -0.05% dep_queue::split4_mod5 11,504 11,498 -6 -0.05% dep_shuttle::deposit 7,861 7,858 -3 -0.04% dep_spl::deposit 7,861 7,858 -3 -0.04% init_eata::init 4,723 4,588 -135 -2.86% init_gvault::init 15,931 15,795 -136 -0.85% init_gvault::migrate 12,998 12,863 -135 -1.04% init_shuttle::init 19,009 18,733 -276 -1.45% init_tq::custom 14,997 14,991 -6 -0.04% init_tq::default 13,530 13,524 -6 -0.04% init_tq::noop 6,424 6,420 -4 -0.06% lamports_pda::allow_extra_lamports 1,876 1,834 -42 -2.24% lamports_pda::sponsored_lamports_transfer 61,282 60,894 -388 -0.63% lamports_pda::transfer_lamports_pda 6,376 6,334 -42 -0.66% merge_shuttle::merge 9,489 9,456 -33 -0.35% rent_pda::init 1,631 1,632 +1 +0.06% rent_pda::reinit 240 241 +1 +0.42% reset_eata_perm::reset 26,531 26,389 -142 -0.54% tq_alloc::already_allocated 1,837 1,837 +0 +0.00% tq_alloc::first_allocate 19,030 19,030 +0 +0.00% tq_auto::crank_1 5,331 5,332 +1 +0.02% tq_auto::crank_2 6,497 6,498 +1 +0.02% tq_auto::crank_bad_magic 807 807 +0 +0.00% tq_auto::enqueue_delayed 10,437 10,431 -6 -0.06% tq_auto::enqueue_ready 10,437 10,431 -6 -0.06% tq_auto::enqueue_with_client_ref_id 10,438 10,434 -4 -0.04% tq_auto::run_scheduled_tick 15,323 15,319 -4 -0.03% tq_auto::run_scheduled_tick_via_magic_bundle 15,321 15,317 -4 -0.03% tq_auto::schedule 5,331 5,332 +1 +0.02% tq_auto::schedule_with_client_ref_id 5,331 5,332 +1 +0.02% tq_auto::tick_after_bundle 2,112 2,106 -6 -0.28% tq_auto::tick_empty 2,112 2,106 -6 -0.28% tq_auto::tick_not_ready 2,198 2,192 -6 -0.27% ud_wd_close::undelegate 13,765 13,743 -22 -0.16% undel_eata_cb::undelegate 36,856 36,856 +0 +0.00% undel_perm_cb::undelegate 34,444 34,444 +0 +0.00% wd_shuttle::withdraw 64,188 63,703 -485 -0.76% wd_spl::withdraw 7,885 7,874 -11 -0.14% ───────────────────────────────────────────────────────────────────────────────

Wow.. that is interesting! sBPF keeps surprising me!

Dodecahedr0x

LGTM

…tion on failure

This was referenced Apr 11, 2026

audit: review selected process_* #62

Merged

chore: reorganize the files #63

Merged

snawaz force-pushed the snawaz/requires branch from 970dd8a to 8f1be18 Compare April 11, 2026 19:36

snawaz force-pushed the snawaz/document branch from 59984b5 to 6c4a505 Compare April 11, 2026 19:36

snawaz marked this pull request as ready for review April 12, 2026 21:15

snawaz force-pushed the snawaz/requires branch from 8f1be18 to a86bc03 Compare April 12, 2026 22:11

snawaz force-pushed the snawaz/document branch from 6c4a505 to 22924c5 Compare April 12, 2026 22:11

snawaz requested a review from GabrielePicco April 13, 2026 11:21

Dodecahedr0x requested changes Apr 14, 2026

View reviewed changes

GabrielePicco approved these changes Apr 14, 2026

View reviewed changes

snawaz requested a review from Dodecahedr0x April 14, 2026 11:48

Dodecahedr0x approved these changes Apr 14, 2026

View reviewed changes

snawaz force-pushed the snawaz/requires branch from 7a885e9 to 49a71dd Compare April 14, 2026 16:38

snawaz force-pushed the snawaz/document branch from 22924c5 to 31df2e2 Compare April 14, 2026 16:38

snawaz force-pushed the snawaz/requires branch from 49a71dd to f6d0663 Compare April 14, 2026 17:14

snawaz force-pushed the snawaz/document branch from 31df2e2 to 675ee63 Compare April 14, 2026 17:14

snawaz force-pushed the snawaz/requires branch from f6d0663 to 7bfe1f6 Compare April 14, 2026 17:20

snawaz force-pushed the snawaz/document branch from 675ee63 to 6ecb17b Compare April 14, 2026 17:20

Base automatically changed from snawaz/document to main April 14, 2026 17:23

snawaz added 4 commits April 14, 2026 22:53

refactor: use requires to assert and automatically log richer informa…

5b94768

…tion on failure

replace require_n_accounts_with_ignored with require_n_accounts

deeb397

use require_n_accounts_with_ignored in process_close_lamports_pda_intent

3dd1146

add require_owned_by and use it

834f628

snawaz force-pushed the snawaz/requires branch from 7bfe1f6 to 834f628 Compare April 14, 2026 17:24

snawaz merged commit 2d13a07 into main Apr 14, 2026
3 checks passed

snawaz deleted the snawaz/requires branch April 14, 2026 17:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: use requires to assert and automatically log richer information on failure#65

refactor: use requires to assert and automatically log richer information on failure#65
snawaz merged 4 commits intomainfrom
snawaz/requires

snawaz commented Apr 11, 2026 •

edited

Loading

Uh oh!

coderabbitai bot commented Apr 11, 2026 •

edited

Loading

Rate limit exceeded

Uh oh!

snawaz commented Apr 11, 2026 •

edited

Loading

Uh oh!

Dodecahedr0x left a comment

Uh oh!

Uh oh!

Dodecahedr0x Apr 13, 2026

Uh oh!

snawaz Apr 14, 2026

Uh oh!

snawaz Apr 14, 2026

Uh oh!

Dodecahedr0x Apr 14, 2026 •

edited

Loading

Uh oh!

snawaz Apr 14, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Dodecahedr0x left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

snawaz commented Apr 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Apr 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Rate limit exceeded

Uh oh!

snawaz commented Apr 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Dodecahedr0x left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Dodecahedr0x Apr 13, 2026

Choose a reason for hiding this comment

Uh oh!

snawaz Apr 14, 2026

Choose a reason for hiding this comment

Uh oh!

snawaz Apr 14, 2026

Choose a reason for hiding this comment

Uh oh!

Dodecahedr0x Apr 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

snawaz Apr 14, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Dodecahedr0x left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

snawaz commented Apr 11, 2026 •

edited

Loading

coderabbitai bot commented Apr 11, 2026 •

edited

Loading

snawaz commented Apr 11, 2026 •

edited

Loading

Dodecahedr0x Apr 14, 2026 •

edited

Loading